<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - dijon.EventMap</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/dijon.html">dijon</a></li>
	
	<li><a href="../symbols/dijon.Actor.html">dijon.Actor</a></li>
	
	<li><a href="../symbols/dijon.Context.html">dijon.Context</a></li>
	
	<li><a href="../symbols/dijon.Dictionary.html">dijon.Dictionary</a></li>
	
	<li><a href="../symbols/dijon.EventDispatcher.html">dijon.EventDispatcher</a></li>
	
	<li><a href="../symbols/dijon.EventMap.html">dijon.EventMap</a></li>
	
	<li><a href="../symbols/dijon.Injector.html">dijon.Injector</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class dijon.EventMap
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				
			
				dijon.EventMap
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/_Users_creynder_Documents_Projects_CREY - dijon_dev_src_dijon.js.html">dijon.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class dijon.EventMap.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/dijon.EventMap.html#constructor">dijon.EventMap</a></b>()
							</div>
							<div class="description">registers class members as listeners for specific events, before (or after) instantiation.</div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class dijon.EventMap.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/dijon.EventMap.html#addClassMapping">addClassMapping</a></b>(eventType, clazz, handler, oneShot, passEvent)
								</div>
								<div class="description">maps <code>handler</code> as a listener for <code>eventType</code> to be called as a member of a <code>clazz</code>
instance.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/dijon.EventMap.html#addRuledMapping">addRuledMapping</a></b>(eventType, key, handler, oneShot, passEvent)
								</div>
								<div class="description">maps <code>handler</code> as a listener for <code>eventType</code> to be called as an instance member of the class mapped to <code>key</code>
instance.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/dijon.EventMap.html#hasMapping">hasMapping</a></b>(eventType, key, handler)
								</div>
								<div class="description">Checks whether a mapping exists.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/dijon.EventMap.html#removeClassMapping">removeClassMapping</a></b>(eventType, clazz, handler)
								</div>
								<div class="description">Removes the mapping for <code>clazz</code></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/dijon.EventMap.html#removeRuledMapping">removeRuledMapping</a></b>(eventType, key, handler)
								</div>
								<div class="description">Removes the mapping for <code>key</code></div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>dijon.EventMap</b>()
				</div>
				
				<div class="description">
					registers class members as listeners for specific events, before (or after) instantiation.<br/>
Allows for mapping listeners to lazily instantiated objects.<br/>
[!] This class differs substantially from the RobotLegs EventMap both in use and functionality
					
				</div>
				
				
				
				
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="addClassMapping"> </a>
					<div class="fixedFont">
					
					
					<b>addClassMapping</b>(eventType, clazz, handler, oneShot, passEvent)
					
					</div>
					<div class="description">
						maps <code>handler</code> as a listener for <code>eventType</code> to be called as a member of a <code>clazz</code>
instance. The instance will ALWAYS be a new one, regardless of previous injector mappings for that <code>clazz</code>.<br/>
If <code>handler</code> is <code>undefined</code> or <code>null</code> the instance will be created but no handler will be invoked.<br/>
In that case the dispatched payload will not be passed. (no constructor injection at the moment)
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>eventType</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Class}</span> <b>clazz</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>handler</b>
									<i>Optional, Default: null</i>
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>oneShot</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>passEvent</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="addRuledMapping"> </a>
					<div class="fixedFont">
					
					
					<b>addRuledMapping</b>(eventType, key, handler, oneShot, passEvent)
					
					</div>
					<div class="description">
						maps <code>handler</code> as a listener for <code>eventType</code> to be called as an instance member of the class mapped to <code>key</code>
instance. The instance will be created according to the rule defined for <code>key</code> in injector.
<br/>[!] requires <code>key</code> is already ruled by the injector
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>eventType</b>
									
								</dt>
								<dd>The name of the event to be listened to</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>key</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>handler</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>oneShot</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>Whether the listener must be called only once</dd>
							
								<dt>
									<span class="light fixedFont">{Boolean}</span> <b>passEvent</b>
									<i>Optional, Default: false</i>
								</dt>
								<dd>Whether the event object should be passed as a parameter to <code>handler</code>
upon invocation or not. If <code>true</code> any additional dispatched values will be passed as parameters after
the event object</dd>
							
							</dl>
						
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/dijon.Injector.html">dijon.Injector</a></dd>
							
							</dl>
						

					<hr />
				
					<a name="hasMapping"> </a>
					<div class="fixedFont">
					
					<span class="light">{Boolean}</span>
					<b>hasMapping</b>(eventType, key, handler)
					
					</div>
					<div class="description">
						Checks whether a mapping exists. The combination of <code>eventType, key, handler</code> must be identical
to what was mapped for this to return true. If <code>key</code> was mapped for <code>eventType</code> <strong>with</strong>
a <code>handler</code> then <code>hasMapping</code> will return <code>false</code> if only invoked with parameters
<code>eventType</code> and <code>key</code>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>eventType</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>key</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>handler</b>
									<i>Optional, Default: null</i>
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> </dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="removeClassMapping"> </a>
					<div class="fixedFont">
					
					
					<b>removeClassMapping</b>(eventType, clazz, handler)
					
					</div>
					<div class="description">
						Removes the mapping for <code>clazz</code>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>eventType</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Class}</span> <b>clazz</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>handler</b>
									<i>Optional, Default: null</i>
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/dijon.EventMap.html#addClassMapping">dijon.EventMap#addClassMapping</a></dd>
							
							</dl>
						

					<hr />
				
					<a name="removeRuledMapping"> </a>
					<div class="fixedFont">
					
					
					<b>removeRuledMapping</b>(eventType, key, handler)
					
					</div>
					<div class="description">
						Removes the mapping for <code>key</code>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{String}</span> <b>eventType</b>
									
								</dt>
								<dd>The name of the event to be listened to</dd>
							
								<dt>
									<span class="light fixedFont">{Class}</span> <b>key</b>
									
								</dt>
								<dd></dd>
							
								<dt>
									<span class="light fixedFont">{Function}</span> <b>handler</b>
									
								</dt>
								<dd></dd>
							
							</dl>
						
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd><a href="../symbols/dijon.EventMap.html#addRuledMapping">dijon.EventMap#addRuledMapping</a></dd>
							
							</dl>
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Wed Oct 19 2011 10:16:19 GMT+0200 (CEST)
		</div>
	</body>
</html>
